/*
 * Copyright 2006 Jerry Huxtable
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.alee.graphics.filters;

import java.awt.*;
import java.awt.geom.AffineTransform;
import java.awt.image.BufferedImage;

/**
 * A filter which composites two images together with an optional transform.
 *
 * @author Jerry Huxtable
 */
public class CompositeFilter extends AbstractBufferedImageOp
{
    private Composite composite;
    private AffineTransform transform;

    /**
     * Construct a CompositeFilter.
     */
    public CompositeFilter ()
    {
    }

    /**
     * Construct a CompositeFilter.
     *
     * @param composite the composite to use
     */
    public CompositeFilter ( final Composite composite )
    {
        this.composite = composite;
    }

    /**
     * Construct a CompositeFilter.
     *
     * @param composite the composite to use
     * @param transform a transform for the composited image
     */
    public CompositeFilter ( final Composite composite, final AffineTransform transform )
    {
        this.composite = composite;
        this.transform = transform;
    }

    /**
     * Set the composite.
     *
     * @param composite the composite to use
     * @see #getComposite
     */
    public void setComposite ( final Composite composite )
    {
        this.composite = composite;
    }

    /**
     * Get the composite.
     *
     * @return the composite to use
     * @see #setComposite
     */
    public Composite getComposite ()
    {
        return composite;
    }

    /**
     * Set the transform.
     *
     * @param transform the transform to use
     * @see #getTransform
     */
    public void setTransform ( final AffineTransform transform )
    {
        this.transform = transform;
    }

    /**
     * Get the transform.
     *
     * @return the transform to use
     * @see #setTransform
     */
    public AffineTransform getTransform ()
    {
        return transform;
    }

    @Override
    public BufferedImage filter ( final BufferedImage src, BufferedImage dst )
    {
        if ( dst == null )
        {
            dst = createCompatibleDestImage ( src, null );
        }

        final Graphics2D g = dst.createGraphics ();
        g.setRenderingHint ( RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON );
        g.setRenderingHint ( RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BILINEAR );
        g.setComposite ( composite );
        g.drawRenderedImage ( src, transform );
        g.dispose ();
        return dst;
    }

    @Override
    public String toString ()
    {
        return "Composite";
    }
}